home *** CD-ROM | disk | FTP | other *** search
/ SPACE 1 / SPACE - Library 1 - Volume 1.iso / misc~1 / 123 / stcitdoc.arc / UTIL.DOC < prev    next >
Encoding:
Text File  |  1987-09-09  |  6.2 KB  |  150 lines
  1. UTIL.DOC
  2.  
  3.  
  4.                 Introduction
  5.  
  6.     Since the days of yore when we received Citadel (the Z80 version
  7. of Citadel, that is...) from CUG (C User's Group), several utilities
  8. of interest have been added to the package to supplement the
  9. original two .com files that came with the package, to wit CITADEL.COM
  10. and CONFIGUR.COM.  These come in two types: one, to provide
  11. information about what's going on inside this monster which, due to
  12. runtime space considerations, could not be gotten at; two, the
  13. ability to change certain parameters which were either impossible to
  14. change once a BBS was set up, or were, at the least, difficult to
  15. change.
  16.     The descriptions (such as they are) follow herein!
  17.  
  18. ----------------------------------------------------------------------
  19.  
  20.                 CLOG.TOS
  21.  
  22. Clog provides access to the userlog for the Sysop.  To use it, the
  23. file CTDLTABL.SYS (the one generated by CONFIGUR and maintained by
  24. CITADEL.COM) must be on the default disk, and so must be CTDLLOG.SYS.
  25.  
  26.     There are two ways of using Clog.  First, there is the simple call:
  27.  
  28.     $ clog
  29.  
  30.     This will print out on the console the list of users in the file
  31. as they appear in the file.  The user of this program should be
  32. warned that Citadel does not put new users into the userlog in
  33. sequential order.  Instead, they are hashed into the log.  Usually,
  34. first user to log into the system ends up occupying the last
  35. position in the file!  In general, users are sprinkled everywhere,
  36. so don't be alarmed if nothing shows up right away.  Be patient.
  37.  
  38.     In any case, the list is printed out as follows.  First, the log
  39. position will be printed out, which will always be in sequential
  40. order.    If nobody occupies that position, then Clog proceeds to the
  41. next log position.  If somebody does occupy that position, then the
  42. name of that person (or alias) will be printed out, followed by his/her
  43. status as aide, expert/non-expert, and screen width.
  44.  
  45.     The second way to use Clog is to give it arguments.  There are
  46. two arguments currently available in the GEMDOS version; the -p
  47. argument and the -a argument.
  48.  
  49.       $ clog -p -a
  50.  
  51.     -p will cause the passwords to be listed along with the user's
  52. name. This is very useful if somebody forgets their password. -a
  53. will only list the aides on the system (this was put in because some
  54. unscrupulous users might make themselves aides if they get access to
  55. the system console).
  56.  
  57.     If, for some reason, the sysop wants a list to be put out to a
  58. file, use the GEMDOS re-direction commands. If you want the list to
  59. be put out to the file LISTING, then type
  60.  
  61.       $ clog >listing
  62.  
  63.     Naturally, arguments may still be used when re-directing output.
  64.  
  65.  
  66. ----------------------------------------------------------------------
  67.  
  68.                 EXPAND.TOS
  69.  
  70.  
  71.     Expand's purpose in life is to allow the sysop to expand the
  72. size of his/her message file (CTDLMSG.SYS).  This makes it easy to
  73. move upwards as one gets rich running Citadel for cold, hard cash
  74. and acquires better and better equipment.
  75.  
  76.     Expand expects to find the file CTDLTABL.SYS on the default disk
  77. in the default user area and the CTDLMSG.SYS file on MSGDISK.
  78. Simply call Expand without arguments.  Once it has loaded CTDLTABL.SYS,
  79. it will display the current size of the message file, and then ask
  80. for the new size.  Then Expand will do it's job. THIS IS A SLOW
  81. PROCESS.  Be patient.  The program will be printing some stuff out
  82. that might allow the sysop to figure out where the program is.
  83.  
  84.     Once the program is done, it will say so, and will also tell you
  85. that there is no reason to reconfigure.  This is true -- But you should
  86. update CTDLCNFG.SYS immediately*.
  87.  
  88.  
  89. ----------------------------------------------------------------------
  90.  
  91.                 LEXPAND.TOS
  92.    
  93.    
  94.    The LEXPAND utility allows the sysop to expand his log beyond the
  95. size selected for when the system was originally configured.  This
  96. program does NOT destroy the log file, it merely enlarges it.
  97.  
  98.    Usage: Make sure that the log file is in it's usual drive. Call
  99. Lexpand. After some grinding, it'll state the old size and ask for
  100. the new size. Give it the new size, and sit back. It'll announce
  101. when it is done and remind you to modify CTDLCNFG.SYS accordingly.
  102.  
  103.  
  104. ----------------------------------------------------------------------
  105.  
  106.                 LOGEDIT.TOS
  107.  
  108.  
  109.    LOGEDIT is provided for when strange things start happening in
  110. the log file, such as duplicate or semi-duplicate logs start
  111. appearing. LOGEDIT lets the sysop change a users name, password,
  112. or kill the account.
  113.  
  114.    To run, make sure the disk with the #sysDir files is in its
  115. normal position, and run LOGEDIT. Logedit will ask for a user
  116. number to modify -- this is the users position in the call log.
  117. (This can be gotten from CLOG.TOS.)
  118.  
  119.  
  120. ----------------------------------------------------------------------
  121.                 POPULAR.TOS
  122.  
  123.  
  124.     The POPULAR utility is a statistics-gathering utility, and, as
  125. such, can be easily viewed as your basic feeping creaturism.  However,
  126. for those of us who have somehow acquired that horrible taste for
  127. odd statistics about how people use Citadel, it does serve some
  128. purpose.
  129.  
  130.     POPULAR gathers statistics about the Public rooms on a system. 
  131. These statistics consist of simply calculating how many people have
  132. forgotten each Public room on a system.  Yes, a rather odd statistic
  133. to gather, but there it is.  Once it has finished processing the data,
  134. it displays the results in tabular form, in (roughly) the following
  135. form:
  136.  
  137. <room name>    <# of people who have forgotten this room> <% of total users>
  138.  
  139.     To use this utility, simply make sure your data files are in
  140. their normal drives, and run this program.  The output of this
  141. program may be redirected to a file via the GEMDOS ">" directive,
  142. although not all the output will end up in the output file.
  143. Unimportant output will continue to go to the screen; the important
  144. data will end up in the file you designated.
  145.  
  146.    There is one command line option available, "-m".  If this option
  147. is on the command line to Popular, it will also scan the message file,
  148. counting the number of messages that originated in each room, and
  149. display that value for each public room in the same tabular format.
  150.